Document possible values for webhook target type#41884
Closed
jothilakshmij wants to merge 2 commits intogithub:mainfrom
Closed
Document possible values for webhook target type#41884jothilakshmij wants to merge 2 commits intogithub:mainfrom
jothilakshmij wants to merge 2 commits intogithub:mainfrom
Conversation
Added possible values for X-GitHub-Hook-Installation-Target-Type header.
Contributor
How to review these changes 👓Thank you for your contribution. To review these changes, choose one of the following options: A Hubber will need to deploy your changes internally to review. Table of review linksNote: Please update the URL for your staging server or codespace. The table shows the files in the
Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server 🤖 This comment is automatically generated. |
|
@jothilakshmij @Sharra-writes What is the status of this PR? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added possible values for X-GitHub-Hook-Installation-Target-Type header.
Why:
The documentation for the X-GitHub-Hook-Installation-Target-Type webhook delivery header previously described its purpose but did not specify the possible values it may contain. This lack of detail made it difficult for developers to reliably distinguish between repository, organization, and GitHub App webhooks using header information alone.
This change improves clarity and completeness for developers implementing webhook handlers.
Closes: #41739
What's being changed (included screenshots):
Included concise descriptions for each value to clearly indicate the webhook source.
Added a short explanatory note describing how this header can be used to distinguish webhook origins without relying solely on the payload structure.
This update is documentation-only and does not change any existing webhook behavior.
Check off the following: